Index | Entity Formatter API

A

EfAddressFieldFormatter::address() — Method in class EfAddressFieldFormatter: Returns an formatted address. By default the formatting handlers from the widget are used.
EfFieldFormatter::all() — Method in class EfFieldFormatter: Returns an array of all field items as EfFieldFormatter objects.
EfImageFormatter::alt() — Method in class EfImageFormatter: Returns the alt attribute for this image.

C

EfAddressFieldFormatter::country() — Method in class EfAddressFieldFormatter: Returns the country name of this address.
EfAddressFieldFormatter::city() — Method in class EfAddressFieldFormatter: Returns the city of this address.
EfAddressFieldFormatter::company() — Method in class EfAddressFieldFormatter: Returns the company of this address.
EfDateFormatter::customFormatted() — Method in class EfDateFormatter: Returns a date formatted which the given or currently set PHP date format string.
EfFieldFormatter::count() — Method in class EfFieldFormatter: Implementing Countable interface.
EfFieldFormatterIterator::current() — Method in class EfFieldFormatterIterator

D

EfDateFormatter::date() — Method in class EfDateFormatter: Returns a timestamp for current date field item.
EfDateFormatter::duration() — Method in class EfDateFormatter: Return the duration from start to enddate as a string using format_interval.
EfFileFormatter::description() — Method in class EfFileFormatter: Returns the textual description if it is available.

E

EfAddressFieldFormatter: Provides formatting methods for addressfield field type.
EfDateFormatter: Provides formatting methods for date, datetime and datestamp field types.
EfDateFormatter::enddate() — Method in class EfDateFormatter: Returns a timestamp of the enddate for current date field item.
EfEntityFormatter: Wraps an entity using an EntityMetadataWrapper.
EfEntityFormatter::entityMetadataWrapper() — Method in class EfEntityFormatter: Retrieve the EntityMetadataWrapper object.
EfEntityFormatter::entity() — Method in class EfEntityFormatter: Retrieve the wrapped entity.
EfEntityReferenceFormatter: Provides formatting methods for taxonomy_term_reference, field_collection and entityreference field types.
EfEntityReferenceFormatter::entityIsAccessible() — Method in class EfEntityReferenceFormatter: Checks if current user has access to the referenced entity.
EfFieldFormatter: Base class for Entity fields. Extend this class to implement custom field formatter.
EfFieldFormatterIterator: Allows to easily iterate over field items.
EfFileEntityFormatter: Work in Progress.
EfFileFormatter: Provides formatting methods for file field types.
EfImageFormatter: Provides formatting methods for image field types.
EfLinkFormatter: Provides formatting methods for link_field field types.
EfListFormatter: Provides formatting methods for list_boolean, list_float, list_integer and list_\text field types.
EfTextFormatter: Provides formatting methods for text, text_long and text_with_summary field types.
EfViewFieldFormatter: Provides formatting methods for viewfield</code field type.

`F`


        EfDateFormatter::formatted() — Method in class EfDateFormatter
                    Returns a date formatted which the given or currently set date format.
EfFileFormatter::filesize() — Method in class EfFileFormatter
                    Return a formatted filesize.
EfFileFormatter::filetype() — Method in class EfFileFormatter
                    Return a filetype.
        
G
        EfEntityReferenceFormatter::getFormatter() — Method in class EfEntityReferenceFormatter
                    Returns a EfEntityFormatter for the specific entity type and bundle to access single fields on this entity.
EfFieldFormatter::getIterator() — Method in class EfFieldFormatter
                    Implementing IteratorAggregate interface.
        
H
        EfDateFormatter::hasEnddate() — Method in class EfDateFormatter
                    Checks if an enddate is specified for the current date field item.
EfImageFormatter::height() — Method in class EfImageFormatter
                    Returns the height for this image.
        
I
        EfEntityFormatter::id() — Method in class EfEntityFormatter
                    Retrieve the entity ID
EfFieldFormatter::isDeltaValid() — Method in class EfFieldFormatter
                    Checks if the given or current field delta exists.
EfFieldFormatter::isAccessible() — Method in class EfFieldFormatter
                    Check if current user is allowed to view this field.
EfImageFormatter::img() — Method in class EfImageFormatter
                    Returns an  tag for this image.
        
K
        EfFieldFormatterIterator::key() — Method in class EfFieldFormatterIterator
                    
EfListFormatter::key() — Method in class EfListFormatter
                    Returns the current field item key.
        
L
        EfEntityFormatter::label() — Method in class EfEntityFormatter
                    Retrieve the entity label
EfEntityReferenceFormatter::label() — Method in class EfEntityReferenceFormatter
                    Returns the label of this entity.
EfEntityReferenceFormatter::linkedLabel() — Method in class EfEntityReferenceFormatter
                    Returns the node title wrapped in a link to the detail page of this entity.
EfFileFormatter::link() — Method in class EfFileFormatter
                    Returns link to this file generated with theme_file_link
EfLinkFormatter::link() — Method in class EfLinkFormatter
                    Returns a rendered link of the current link field item.
EfListFormatter::label() — Method in class EfListFormatter
                    Returns the current field item label.
        
N
        EfAddressFieldFormatter::name() — Method in class EfAddressFieldFormatter
                    Returns the name line of this address.
EfFieldFormatter::notEmpty() — Method in class EfFieldFormatter
                    Shortcut for the possible not so easy to understand isDeltaValid() method.
EfFieldFormatterIterator::next() — Method in class EfFieldFormatterIterator
                    
EfFileFormatter::name() — Method in class EfFileFormatter
                    Returns the filename.
        
P
        EfAddressFieldFormatter::postalCode() — Method in class EfAddressFieldFormatter
                    Returns the postal code of this address.
EfEntityReferenceFormatter::path() — Method in class EfEntityReferenceFormatter
                    Returns the path to the detail page of this entity.
        
R
        EfEntityReferenceFormatter::render() — Method in class EfEntityReferenceFormatter
                    Renders an entity using the set view mode.
EfFieldFormatterIterator::rewind() — Method in class EfFieldFormatterIterator
                    
EfFileEntityFormatter::render() — Method in class EfFileEntityFormatter
                    Render an file entity with a view mode.
EfImageFormatter::relativePath() — Method in class EfImageFormatter
                    Returns the relative path including query (itok).
EfViewFieldFormatter::render() — Method in class EfViewFieldFormatter
                    
        
S
        EfAddressFieldFormatter::setHandlers() — Method in class EfAddressFieldFormatter
                    Set formatting handlers for this addressfield.
EfAddressFieldFormatter::street() — Method in class EfAddressFieldFormatter
                    Returns the street of this address.
EfDateFormatter::setFormat() — Method in class EfDateFormatter
                    Set the date format name which will be used for printing the date.
EfDateFormatter::setCustomFormat() — Method in class EfDateFormatter
                    Set a custom PHP date format string which will be used for printing the date.
EfEntityFormatter::setLanguage() — Method in class EfEntityFormatter
                    Set the language to be used. Please note that EntityMetadataWrapper always
falls back to the language of the entity, if a field is not available in a
given language.
EfEntityReferenceFormatter::setViewMode() — Method in class EfEntityReferenceFormatter
                    Sets the view mode which is used to render this entity.
EfFieldFormatter::setDelta() — Method in class EfFieldFormatter
                    Set the current field delta.
EfImageFormatter::setImageStyle() — Method in class EfImageFormatter
                    Set the image style which is used when printing this image.
EfImageFormatter::src() — Method in class EfImageFormatter
                    Returns the URL for this image.
EfTextFormatter::setTruncate() — Method in class EfTextFormatter
                    Sets the number of characters after which to truncate.
EfTextFormatter::summary() — Method in class EfTextFormatter
                    Returns the summary of this text or a truncated version of the text.
        
T
        EfImageFormatter::title() — Method in class EfImageFormatter
                    Returns the title attribute for this image.
EfTextFormatter::text() — Method in class EfTextFormatter
                    Returns the textual value of this field at the current delta.
EfTextFormatter::truncate() — Method in class EfTextFormatter
                    Hard cuts the string after a given character count and adds an ellipsis.
        
U
        EfEntityFormatter::url() — Method in class EfEntityFormatter
                    Returns an URL to the detail page of this entity.
EfEntityReferenceFormatter::url() — Method in class EfEntityReferenceFormatter
                    Returns an URL to the detail page of this entity.
EfFileFormatter::url() — Method in class EfFileFormatter
                    Returns the URL for this file.
EfLinkFormatter::url() — Method in class EfLinkFormatter
                    Returns the URL of the current link field item.
        
V
        EfFieldFormatter::value() — Method in class EfFieldFormatter
                    Returns the current field item as a raw array.
EfFieldFormatter::values() — Method in class EfFieldFormatter
                    Returns all raw field items in an array.
EfFieldFormatterIterator::valid() — Method in class EfFieldFormatterIterator
                    
        
W
        EfImageFormatter::width() — Method in class EfImageFormatter
                    Returns the width for this image.
        
_
        EfAddressFieldFormatter::__construct() — Method in class EfAddressFieldFormatter
                    Constructor.
EfAddressFieldFormatter::__toString() — Method in class EfAddressFieldFormatter
                    
EfDateFormatter::__toString() — Method in class EfDateFormatter
                    
EfEntityFormatter::__construct() — Method in class EfEntityFormatter
                    Wrap an entity.
EfEntityReferenceFormatter::__construct() — Method in class EfEntityReferenceFormatter
                    Constructor.
EfEntityReferenceFormatter::__toString() — Method in class EfEntityReferenceFormatter
                    
EfFieldFormatter::__construct() — Method in class EfFieldFormatter
                    Constructor.
EfFieldFormatterIterator::__construct() — Method in class EfFieldFormatterIterator
                    
EfFileEntityFormatter::__construct() — Method in class EfFileEntityFormatter
                    Constructor.
EfFileFormatter::__construct() — Method in class EfFileFormatter
                    Constructor.
EfFileFormatter::__toString() — Method in class EfFileFormatter
                    
EfImageFormatter::__toString() — Method in class EfImageFormatter
                    
EfLinkFormatter::__toString() — Method in class EfLinkFormatter
                    
EfListFormatter::__toString() — Method in class EfListFormatter
                    
EfTextFormatter::__toString() — Method in class EfTextFormatter
                    
EfViewFieldFormatter::__toString() — Method in class EfViewFieldFormatter


                
        Generated by Sami, the API Documentation Generator.